/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.apache.iotdb.db.queryengine.plan.relational.planner.assertions;

import com.google.common.collect.ImmutableList;

import java.util.List;

import static java.util.Objects.requireNonNull;

/**
 * A PlanMatchingState is a list of patterns representing a potential match for the sources of a
 * PlanMatchNode. There is a 1:1 correspondence between the elements of the patterns and the
 * sources.
 *
 * <p>Example: During the matching process, a PlanMatchingState with patterns [pattern1, pattern2]
 * is generated while visiting a PlanNode with sources [sourceA, sourceB]. The matching process will
 * attempt the following matches: [pattern1 : sourceA, pattern2 : sourceB]
 */
final class PlanMatchingState {
  private final List<PlanMatchPattern> patterns;

  PlanMatchingState(List<PlanMatchPattern> patterns) {
    requireNonNull(patterns, "patterns is null");
    this.patterns = ImmutableList.copyOf(patterns);
  }

  boolean isTerminated() {
    return patterns.isEmpty() || patterns.stream().allMatch(PlanMatchPattern::isTerminated);
  }

  List<PlanMatchPattern> getPatterns() {
    return patterns;
  }
}
